home *** CD-ROM | disk | FTP | other *** search
/ Libris Britannia 4 / science library(b).zip / science library(b) / COMMUNIC / 0717.ZIP / MSKERM.HLP < prev    next >
Text File  |  1987-05-24  |  9KB  |  283 lines
  1.   MS-DOS KERMIT for the IBM PC family, compatibles, and other MS-DOS Systems
  2.  
  3.                             Version 2.29, May 1986
  4.  
  5.                                 PROGRAM SUMMARY
  6.                       See MSKERM.DOC for complete details
  7.  
  8.  
  9. Kermit-MS can be run interactively, from a batch file, or as an "external" DOS
  10. command.  Upon initial startup, the program executes any commands found in the
  11. file MSKERMIT.INI in the current path.
  12.  
  13. * Interactive Operation:
  14.  
  15. To run Kermit-MS interactively, invoke the program from DOS command level by
  16. typing its name, usually "kermit".  When you see the command's prompt,
  17. "Kermit-MS>", you may type Kermit commands repeatedly until you are ready to
  18. exit the program.
  19.  
  20. While typing commands, use BACKSPACE to erase the character most recently
  21. typed, Ctrl-W to delete the most recent field, or Ctrl-U to delete the entire
  22. command, and enter the command by typing RETURN (Carriage Return, Enter), or
  23. Ctrl-L.  While typing commands, you may use the help ("?") and keyword
  24. completion (ESC) features freely.
  25.  
  26. * Command Line Invocation:
  27.  
  28. Kermit-MS may be invoked with command line arguments from DOS command level,
  29. for instance:
  30.  
  31.     A>kermit set port 1, set baud 9600, connect
  32.  
  33. In this case, help and completion are not available and Kermit-MS will exit
  34. back to DOS after completing the specified commands.  Several commands may be
  35. given on the command line, separated by commas.
  36.  
  37. * Batch Operation:
  38.  
  39. Like other MS-DOS programs, Kermit-MS may be operated under batch with command
  40. line arguments.  If you invoke it without command line arguments, it will run
  41. interactively, reading commands from the keyboard and not the batch file.  When
  42. it exits, batch processing will continue to the end of the batch file.
  43.  
  44. * Remote Operation:
  45.  
  46. The MS-DOS CTTY command allows an MS-DOS system to be used from a terminal
  47. connected to its communication port.  Kermit, however, cannot work in this
  48. environment.  To use Kermit on the remote PC, use a DOS batch file that
  49. contains commands like this:
  50.  
  51. CTTY CON
  52. KERMIT SERVER
  53. CTTY COM1
  54.  
  55. and run the batch file instead of Kermit itself.  When you give the FINISH
  56. or BYE command to the server, you will be able to connect back to the remote
  57. PC and continue your DOS session.
  58.  
  59.  
  60. * Top-Level Kermit-MS Commands:
  61.  
  62. BYE
  63.   Shut down remote server.
  64. CLEAR
  65.   Remove key redefinitions.
  66. CLOSE
  67.   Close log file and stop logging remote session.
  68. COMMENT <string>
  69.   Add comments to TAKE command file.  
  70. CONNECT
  71.   Make a terminal connection to the remote system.
  72. CWD <path>
  73.   Change local working directory.
  74. DEFINE <macro-name> [<definition>]
  75.   Group Kermit-MS commands together into a macro command.
  76. DELETE <filespec>
  77.   Delete local files.
  78. DIRECTORY [<filespec>]
  79.   List names, sizes, and dates of local files.
  80. DO <macro-name>
  81.   Perform the commands in a macro.
  82. EXIT
  83.   Exit from Kermit-MS.
  84. FINISH
  85.   Shut down remote server.
  86. GET <remote-filespec>
  87.   Get remote files from server.
  88. HANGUP
  89.   Instruct modem to hangup the phone (drop DTR, RTS).
  90. HELP
  91.   Display brief help message about Kermit-MS.
  92. LOCAL <command>
  93.   Prefix for local file management commands.
  94. LOG <filespec>
  95.   Record remote terminal session in specified file or device.
  96. LOGOUT
  97.   Logout remote server, don't exit from Kermit-MS.
  98. PUSH
  99.   Invoke inferior MS-DOS command processor, EXIT DOS to return.
  100. QUIT
  101.   Exit from Kermit-MS.
  102. RECEIVE <alternate-name>
  103.   Wait for files from remote Kermit.
  104. REMOTE <command>
  105.   Prefix for commands to remote Kermit server (see below).
  106. RUN <program> [<arguments>]
  107.   Invoke an MS-DOS program, optionally with command-line arguments
  108. SEND <filename> [<alternate-name>]
  109.   Send files to remote Kermit receiver or server.
  110. SERVER
  111.   Act as a Kermit server.
  112. SET <parameter> <value>
  113.   Set various parameters (see below).
  114. SHOW
  115.   Macros or keys
  116. SPACE
  117.   Show disk space
  118. STATUS
  119.   Show values of SET parameters
  120. TAKE <filespec>
  121.   Execute Kermit-MS commands from specified file.
  122. TYPE <filespec>
  123.   Display a local file on the screen.
  124. VERSION
  125.   Display Kermit-MS program version number.
  126.  
  127. * File specifications:
  128.  
  129. In all commands, file specifications may include fully qualified DOS paths,
  130. including device specifications.  Allowable wildcard characters are "*"
  131. (match from here to end of field) and "?" (single character), as in DOS,
  132. except "#" must be used instead of "?" to match the first character of a
  133. filename.
  134.  
  135. * Interruption commands while a file transfer in progress:
  136.  
  137. ^X Stop sending the current file and go on to the next one, if any.
  138. ^Z Stop sending this file, and don't send any further files.
  139. ^C Return to Kermit-MS command level immediately.
  140. ^E Send Error packet to the remote Kermit.
  141. CR Simulate a timeout: resend the current packet, or NAK the expected one.
  142.  
  143. * Remote Commands:
  144.  
  145. REMOTE CWD [directory]
  146.   Change remote Working Directory
  147. REMOTE DELETE filespec
  148.   Delete remote file(s)
  149. REMOTE DIRECTORY [filespec]
  150.   List remote file(s)
  151. REMOTE HELP
  152.   Ask the server to list the services it provides.
  153. REMOTE HOST [command]
  154.   Command for remote host in its own command language.
  155. REMOTE SPACE [directory]
  156.   Show disk space on remote host.
  157. REMOTE TYPE filespec
  158.   Display remote file(s)
  159.  
  160. * MS-DOS Kermit server honors the following requests:
  161.  
  162. SEND      REMOTE DELETE       REMOTE CWD
  163. GET       REMOTE DIRECTORY    REMOTE HOST
  164. FINISH    REMOTE SPACE
  165. BYE       REMOTE TYPE
  166.  
  167. * SET commands:
  168.  
  169. BAUD <number>
  170.   Communications port line speed (synonym for SPEED)
  171. BELL {ON,OFF}
  172.   Whether to beep at the end of a transaction
  173. BLOCK-CHECK-TYPE {1,2,3}
  174.   Level of error checking for file transfer
  175. DEBUG {ON,OFF}
  176.   Display packet contents during file transfer
  177. DEFAULT-DISK <disk-name>
  178.   Default disk drive for file i/o
  179. DESTINATION {DISK,PRINTER,SCREEN}
  180.   Default destination device for incoming files
  181. DISPLAY {QUIET,REGULAR,SERIAL}
  182.   For selecting the type of file transfer display
  183. DUMP <filespec>
  184.   Screen dump file (or device) name
  185. END-OF-LINE <ASCII-value>
  186.   Packet termination character
  187. EOF {CTRL-Z,NOCTRL-Z}
  188.   Method for determining or marking end of file
  189. ESCAPE <character>
  190.   Escape character for CONNECT
  191. FLOW-CONTROL {XON/XOFF,NONE}
  192.   Select full-duplex flow control method.
  193. HANDSHAKE CODE <ASCII-value>
  194.   Half-duplex line turnaround character.
  195. INCOMPLETE {DISCARD,KEEP}
  196.   What to do with an incompletely received file.
  197. KEY {Fn,SCAN n}
  198.   Specify key redefinitions, or "keystroke macros"
  199. LOCAL-ECHO {ON,OFF}
  200.   Specify which computer does the echoing during CONNECT
  201. MODE-LINE {ON,OFF}
  202.   Whether to display a mode line during terminal emulation
  203. PARITY {EVEN,ODD,MARK,SPACE,NONE}
  204.   Character parity to use during communication
  205. PORT {1,2}
  206.   Select a communications port
  207. PROMPT <string>
  208.   Change the "Kermit-MS>" prompt to <string>
  209. RECEIVE <parameter> <value>
  210.   Request remote Kermit to use specified parameters (see below)
  211. REMOTE {ON,OFF}
  212.   For running Kermit-MS interactively from back port
  213. RETRY <number>
  214.   Packet retransmission threshold
  215. SEND <parameter> <value>
  216.   Use the specified parameters during file transfer (see below)
  217. SPEED <number>
  218.   Communications port line speed (synonym for BAUD)
  219. TAKE-ECHO {ON,OFF}
  220.   Control echoing of commands from TAKE files
  221. TERMINAL <parameter> <value>
  222.   Emulation and parameters (see below)
  223. TIMER {ON,OFF}
  224.   Enable/disable timeouts during file transfer
  225. WARNING {ON,OFF}
  226.   Specify how to handle filename collisions
  227.  
  228. * SET SEND/RECEIVE parameters:
  229.  
  230. PACKET-LENGTH <number>
  231.   Maximum packet length
  232. PADCHAR <ASCII-value>
  233.   Pre-packet padding character
  234. PADDING <number>
  235.   Number of padding characters per packet
  236. PAUSE <number>
  237.   Intercharacter pause, milliseconds
  238. QUOTE <ASCII-value>
  239.   Control prefix
  240. START-OF-PACKET <ASCII-value>
  241.   Packet-start character
  242. TIMEOUT <number>
  243.   Timeout interval
  244.  
  245. * SET TERMINAL parameters:
  246.  
  247. NONE, VT52, HEATH, VT102 (type of terminal to emulate)
  248. CHARACTER-SET {UK, US}
  249. COLOR number [, number [, number]]
  250.   0   For no snow on IBM Color Graphics Adaptor (CGA)
  251.   1   High intensity
  252.   10  For fast screen update on IBM EGA
  253.   3x  Foreground color
  254.   4x  Background color
  255.       x = Sum of any of: 1 (Red), 2 (Green), 4 (Blue)
  256. CURSOR-STYLE {BLOCK, UNDERLINE}
  257. KEYCLICK {ON, OFF}
  258. MARGIN-BELL {ON, OFF}
  259. NEWLINE-MODE {ON, OFF}
  260. SCREEN-BACKROUND {NORMAL, REVERSE}
  261. TAB {AT n, CLEAR AT n, CLEAR ALL}
  262. WRAP {ON, OFF}
  263.  
  264. * CONNECT escape-level commands:
  265.  
  266.   ?   Help -- prints the available single-character commands.
  267.   0   (the digit zero) Transmit a NUL (ASCII 0).
  268.   B   Transmit a BREAK signal.
  269.   C   Close the connection and return to Kermit-MS prompt level.
  270.   F   File the current screen in the screen dump file.
  271.   M   Toggle the mode line, i.e. turn it off if it is on & vice versa.
  272.   P   Push to DOS; get back to CONNECT by typing EXIT.
  273.   Q   Temporarily quit logging the remote session.
  274.   R   Resume logging the remote session.
  275.   S   Show the status of the connection.
  276.   ^]  (or whatever you have set the escape character to be)
  277.       Typing  the  escape character twice sends one copy of it to the connected
  278.       host.
  279.  
  280. Escape character is normally Ctrl-].  Use SET ESCAPE to change it.
  281.  
  282. [End of MSKERM.HLP]